home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / ACORNUSERS / EMULATOR / MAME33 / readme.txt < prev    next >
Text File  |  1998-07-29  |  20KB  |  376 lines

  1.  
  2.               M.A.M.E.  -  Multiple Arcade Machine Emulator
  3.        Copyright (C) 1997, 1998  by Nicola Salmoria and the MAME team
  4.  
  5. Please note that many people helped with this project, either directly or by
  6. releasing source code that was used to write the drivers. We are not trying to
  7. appropriate merit that isn't ours. See the acknowledgments section for a list
  8. of contributors, however please note that the list is largely incomplete. See
  9. also the CREDITS section in the emulator to see the people who contributed to a
  10. specific driver. Again, that list might be incomplete. We apologize in advance
  11. for any omission.
  12.  
  13. All trademarks cited in this document are property of their respective owners.
  14.  
  15.  
  16. Usage and Distribution License
  17. ------------------------------
  18.  
  19. I. Purpose
  20. ----------
  21.    MAME is strictly a no profit project. Its main purpose is to be a reference
  22.    to the inner workings of the emulated arcade machines. This is done for
  23.    educational purposes and to preserve many historical games from the oblivion
  24.    they would sink into when the hardware they run on will stop working.
  25.    Of course to preserve the games you must also be able to actually play them;
  26.    you can see that as a nice side effect.
  27.    It is not our intention to infringe any copyrights or patents pending on the
  28.    original games. All of the source code is either our own or freely
  29.    available. To work, the emulator requires ROMs of the original arcade
  30.    machines, which must be provided by the user. No portion of the code of the
  31.    original ROMs is included in the executable.
  32.  
  33. II. Cost
  34. --------
  35.    MAME is free. The source code is free. Selling it is not allowed.
  36.  
  37. III. ROM Images
  38. ---------------
  39.    You are not allowed to distribute MAME and ROM images on the same physical
  40.    medium. You are allowed to make them available for download on the same web
  41.    site, but only if you warn users about the copyright status of the ROMs and
  42.    the legal issues involved. You are NOT allowed to make MAME available for
  43.    download together with one giant big file containing all of the supported
  44.    ROMs, or any files containing more than one game each.
  45.    You are not allowed to distribute MAME in any form if you sell, advertise or
  46.    publicize illegal CD-ROMs or other media containing ROM images. Note that
  47.    the restriction applies even if you don't directly make money out of that.
  48.    The restriction of course does not apply if the CD-ROMs are published by the
  49.    ROMs copyrights owners.
  50.  
  51. IV. Source Code Distribution
  52. ----------------------------
  53.    If you distribute the binary, you should also distribute the source code. If
  54.    you can't do that, you must provide a pointer to a place where the source
  55.    can be obtained.
  56.  
  57. V. Distribution Integrity
  58. -------------------------
  59.    This chapter applies to the official MAME distribution. See next chapter for
  60.    limitations on the distribution of derivative works.
  61.    MAME must be distributed only in the original archives. You are not allowed
  62.    to distribute a modified version, nor to remove and/or add files to the
  63.    archive.
  64.  
  65. VI. Reuse of Source Code
  66. -------------------------
  67.    This chapter might not apply to specific portions of MAME (e.g. CPU
  68.    emulators) which bear different copyright notices.
  69.    The source code cannot be used in a commercial product without a written
  70.    authorization of the authors. Use in non commercial products is allowed and
  71.    indeed encouraged; however if you use portions of the MAME source code in
  72.    your program, you must make the full source code freely available as well.
  73.    Derivative works are allowed (provided source code is available), but
  74.    discouraged: MAME is a project continuously evolving, and you should, in
  75.    your best interest, submit your contributions to the development team, so
  76.    that they are integrated in the main distribution. Usage of the
  77.    _information_ contained in the source code is free for any use. However,
  78.    given the amount of time and energy it took to collect this information, we
  79.    would appreciate if you made the additional information you might have
  80.    freely available as well.
  81.  
  82.  
  83.  
  84. How to Contact Us
  85. -----------------
  86.  
  87. Here are some of the people contributing to MAME. If you have comments,
  88. suggestions or bug reports about an existing driver, check the driver's Credits
  89. section to find who has worked on it, and send comments to that person. If you
  90. are not sure who to contact, write to Mirko or Nicola. If you have comments
  91. specific to a system other than DOS (e.g. Mac, Win32, Unix), they should be sent
  92. to the respective port maintainer. DON'T SEND THEM TO MIRKO OR NICOLA - they
  93. will be ignored.
  94.  
  95. You can send source code to mame@lim.dsi.unimi.it. Do not use this address for
  96. non-source code bug reports.
  97.  
  98. Nicola Salmoria    MC6489@mclink.it
  99. Mirko Buffoni      mix@lim.dsi.unimi.it
  100.  
  101. Mike Balfour       mab22@po.cwru.edu
  102. Aaron Giles        agiles@sirius.com
  103. Chris Moore        chris.moore@writeme.com
  104. Brad Oliver        bradman@primenet.com
  105. Andrew Scott       ascott@utkux.utcc.utk.edu
  106. Zsolt Vasvari      vaszs01@banet.net
  107. Valerio Verrando   v.verrando@mclink.it
  108. Bernd Wiebelt      bernardo@studi.mathematik.hu-berlin.de
  109.  
  110. DON'T SEND BINARY ATTACHMENTS WITHOUT ASKING FIRST, *ESPECIALLY* ROM IMAGES.
  111.  
  112. THESE ARE NOT SUPPORT ADDRESSES. Support questions sent to these addresses
  113. *will* be ignored. Please understand that this is a *free* project, mostly
  114. targeted at experienced users. We don't have the resources to provide end user
  115. support. Basically, if you can't get the emulator to work, you are on your own.
  116. First of all, read the docs carefully and check the FAQ at
  117. http://www.crcwnet.com/~no-sleep/newic/mamefaq.htm. If you still can't find an
  118. answer to your question, try checking the beginner's sections that many
  119. emulation pages have (e.g. http://www.crcwnet.com/~no-sleep/newic/), or ask on
  120. the appropriate Usenet newsgroups (e.g. comp.emulators.misc) or on the
  121. emulation message boards (e.g. http://www.escape.com/~ego/dvgc/mame/).
  122.  
  123. Also, DO NOT SEND REQUESTS FOR NEW GAMES TO ADD, unless you have some original
  124. info on the game hardware or, even better, own the board and have the technical
  125. expertise needed to help us.
  126. Please don't send us information widely available on the Internet - we are
  127. perfectly capable of finding it ourselves, thank you.
  128.  
  129.  
  130.  
  131. Acknowledgments
  132. ---------------
  133.  
  134. First of all, thanks to Allard van der Bas (avdbas@wi.leidenuniv.nl) for
  135. starting the Arcade Emulation Programming Repository at
  136. http://valhalla.ph.tn.tudelft.nl/emul8
  137. Without the Repository, I would never have even tried to write an emulator.
  138. Unfortunately, the original Repository is now closed, but its spirit lives
  139. on in MAME.
  140.  
  141. Z80Em Portable Zilog Z80 Emulator Copyright (C) Marcel de Kogel 1996,1997
  142.    Note: the version used in MAME is slightly modified. You can find the
  143.    original version at http://www.komkon.org/~dekogel/misc.html.
  144. M6502 Emulator Copyright (C) Marat Fayzullin, Alex Krasivsky 1996
  145.    Note: the version used in MAME is slightly modified. You can find the
  146.    original version at http://freeflight.com/fms/.
  147. I86 emulator by David Hedley, modified by Fabrice Frances (frances@ensica.fr)
  148. M6809 emulator by John Butler, based on L.C. Benschop's 6809 Simulator V09.
  149. M6808 based on L.C. Benschop's 6809 Simulator V09.
  150. 80x86 asm M6808 emulator Copyright 1998, Neil Bradley, All rights reserved
  151. M68000 emulator taken from the System 16 Arcade Emulator by Thierry Lescot.
  152. 8039 emulator by Mirko Buffoni, based on 8048 emulator by Dan Boris.
  153. T-11 emulator Copyright (C) Aaron Giles 1998
  154. TMS5220 emulator by Frank Palazzolo.
  155. AY-3-8910 emulation based on various code snippets by Ville Hallik,
  156.   Michael Cuddy, Tatsuyuki Satoh, Fabrice Frances, Nicola Salmoria.
  157. YM-2203 and YM-2151 emulation by Tatsuyuki Satoh.
  158. OPL based YM-2203 emulation by Ishmair (ishmair@vnet.es).
  159. POKEY emulator by Ron Fries (rfries@aol.com).
  160. Many thanks to Eric Smith, Hedley Rainnie and Sean Trowbridge for information
  161.    on the Pokey random number generator.
  162. NES sound hardware info by Jeremy Chadwick and Hedley Rainne.
  163.  
  164. Allegro library by Shawn Hargreaves, 1994/97
  165. SEAL Synthetic Audio Library API Interface Copyright (C) 1995, 1996
  166.    Carlos Hasan. All Rights Reserved.
  167. Video modes created using Tweak 1.6b by Robert Schmidt, who also wrote
  168.    TwkUser.c.
  169. "inflate" code for zip file support by Mark Adler.
  170.  
  171. Big thanks to Gary Walton (garyw@excels-w.demon.co.uk) for too many things
  172.    to mention them all.
  173.  
  174. Many thanks to Nicholas Alwin (www.alpha1.net/~v-stick) for the V-Stick. If you
  175.    are seriously into arcade emulation, check it out.
  176.  
  177.  
  178.  
  179. Usage
  180. -----
  181.  
  182. MAME [name of the game to run] [options]
  183.  
  184. for example
  185.  
  186. MAME mspacman -soundcard 0    will run Ms Pac Man without sound
  187.  
  188.  
  189. options:
  190. -scanlines/-noscanlines (default: -scanlines)
  191.               if the default mode doesn't work with your monitor/video card
  192.               (double image/picture squashed vertically), use -noscanlines
  193.               or -vesa.
  194. -vesa/-novesa (default: -novesa)
  195.               Decides whether to use tweaked VGA modes or standard VESA modes.
  196.               Note that some hires games require VESA modes, -novesa is
  197.               ignored in this case.
  198. -ntsc         a 288x224 mode with standard NTSC frequencies. You need some
  199.               additional hardware (VGA2TV converter) to make use of this.
  200. -vesa1        discontinued. use -vesa
  201. -vesa2b       discontinued. use -vesa
  202. -vesa2l       discontinued. use -vesa
  203. -resolution XxY
  204.               where X and Y are width and height (ex: '-resolution 800x600')
  205.               MAME goes some lengths to autoselect a good resolution. You can
  206.               override MAME's choice with this option.
  207.               You can use -XxY (e.g. -800x600) as a shortcut. Frontend
  208.               authors are advised to use -resolution XxY, however.
  209. -320          discontinued. Use -320x240.
  210.               If you get an error '320x240 not supported', you probably
  211.               need Scitech's Display Doctor, which provides the 'de facto'
  212.               standard VESA implementation (http://www.scitechsoft.com)
  213.               Note: this is a nice alternative to '-640x480 -noscanlines'
  214. -400          same as above, use -400x300
  215. -512          same as above, use -512x384
  216. -640          same as above, use -640x480
  217. -800          same as above, use -800x600.
  218. -1024         same as above, use -1024x768
  219. -skiplines N / -skipcolumns N
  220.               if you run a game on a video mode smaller than the visible area,
  221.               you can adjust its position using the PGUP and PGDN keys (alone
  222.               for vertical panning, shifted for horizontal panning).
  223.               You can also use these two parameters to set the initial
  224.               position: 0 is the default, menaing that the screen is centered.
  225.               You can specify both positive and negative offsets.
  226. -double/-nodouble (default: auto)
  227.               use nodouble to disable pixel doubling in VESA modes (faster,
  228.               but smaller picture). Use double to force pixel doubling when
  229.               the image doesn't fit in the screen (you'll have to use PGUP and
  230.               PGDN to scroll).
  231. -depth n      (default: 16)
  232.               Some games need 65k color modes to get accurate graphics. To
  233.               improve speed, you can turn that off using -depth 8, which limits
  234.               to the standard 256 color modes.
  235. -gamma n      (default: 1.2)
  236.               Set the initial gamma correction value.
  237. -vgafreq n    where n can be 0 (default) 1, 2 or 3.
  238.               use different frequencies for the custom video modes. This
  239.               could reduce flicker, especially in the 224x288noscanlines
  240.               mode. WARNING: THE FREQUENCIES USED MIGHT BE WAY OUTSIDE OF
  241.               YOUR MONITOR RANGE, AND COULD EVEN DAMAGE IT. USE THESE OPTIONS
  242.               AT YOUR OWN RISK.
  243. -vsync/-novsync (default: -novsync)
  244.               synchronize video display with the video beam instead of using
  245.               the timer. This option can only be used if the selected video
  246.               mode has an appropriate refresh rate; MAME will otherwise refuse
  247.               to start, telling you the actual refresh rate of the video mode,
  248.               and the rate it should have.
  249.               If you are using a tweaked mode, MAME will try to automatically
  250.               pick the correct setting for -vgafreq; you can still override it
  251.               using the -vgafreq option. Note: the 224x288 noscanlines mode
  252.               doesn't work on most cards. This mode is used by many games,
  253.               e.g. Pac Man and Galaga. If it doesn't work on your card, either
  254.               use the scanlines version, or don't use -vsync.
  255.               If you are using a VESA mode you should use the program which
  256.               came with your video card to set the appropriate refresh rate.
  257.               Note that when this option is turned on, speed will NOT
  258.               downgrade nicely if your system is not fast enough (i.e.:
  259.               jerkier gameplay).
  260. -alwayssynced/-noalwayssynced (default: -noalwayssynced)
  261.               for many tweaked VGA modes, MAME has two definitions: one which
  262.               is more compatible, and one which is less compatible but uses
  263.               frequencies compatible with -vsync. By default, the less
  264.               compatible definition is used only when -vsync is requested;
  265.               using this option, you can force it to be used always.
  266. -ror          rotate the display clockwise by 90 degrees.
  267. -rol          rotate display anticlockwise
  268. -flipx        flip display horizontally
  269. -flipy        flip display vertically
  270.               -ror and -rol provide authentic *vertical* scanlines, given you
  271.               turn your monitor to its side.
  272.               CAUTION:
  273.               A monitor is a complicated, high voltage electronic device.
  274.               There are some monitors that were designed to be rotated.
  275.               If yours is _not_ one of those, but you absolutely must
  276.               turn it to its side, you do so at your own risk.
  277.  
  278.               ******************************************************
  279.               PLEASE DO NOT LET YOUR MONITOR WITHOUT ATTENTION IF IT
  280.               IS PLUGGED IN AND TURNED TO ITS SIDE
  281.               ******************************************************
  282.  
  283. -norotate     This is supposed to disable all internal rotations of the image,
  284.               therefore displaying the video output as it is supposed to be
  285.               (so you need a vertical monitor to see vertical games). However,
  286.               many drivers still don't use MAME centralized rotation, but
  287.               instead rotate the image on their own, so -norotate has no
  288.               effect on them. In some cases, the image will be upside down. To
  289.               correct that, use
  290.               -norotate -flipx -flipy.
  291.  
  292. -soundcard n  select sound card (if this is not specified, you will be asked
  293.               interactively)
  294. -sr n         set the audio sample rate. The default is 22050. Smaller values
  295.               (e.g. 11025) will cause lower audio quality but faster emulation
  296.               speed. Higher values (e.g. 44100) will cause higher audio quality
  297.               but slower emulation speed.
  298. -sb n         set the audio sample bits, either 8 or 16. The default is 8.
  299.               16 will increase quality with certain games, but decrease speed.
  300.               This is a software setting, not hardware. The sound card will
  301.               always be used in 16 bit mode, if possible.
  302. -joy n/-nojoy (default: -nojoy) allows joystick input, n can be:
  303.               0 - no joystick
  304.               1 - normal 2 button joystick
  305.               2 - dual joysticks
  306.               3 - Stick/Pad with 4 buttons
  307.               4 - Stick/Pad with 6 buttons
  308.               5 - Stick/Pad with 8 buttons
  309.               6 - CH Flightstick Pro
  310.               7 - Wingman Extreme (or Wingman Warrior without spinner)
  311.               8 - Microsoft Sidewinder (up to 4)
  312.               9 - Gravis GamePad Pro
  313.  
  314.               Press F7 to calibrate analog joysticks. Calibration data
  315.               will be saved in mame.cfg. If you're using different joytypes
  316.               for different games, you may need to recalibrate your joystick
  317.               every time.
  318.  
  319. -fm/-nofm (default: -nofm) use the SoundBlaster OPL chip for music emulation
  320.               in some games. This is faster, but emulation is less faithful.
  321. -log          create a log of illegal memory accesses in ERROR.LOG
  322. -help, -?     display current MAME version and copyright notice
  323. -list         display a list of currently supported games
  324. -listfull     display a list of game directory names + description
  325. -listroms     display selected game required roms
  326. -listsamples  display selected game required samples
  327. -listdetails  display a detailed list of drivers and the hardware they use
  328. -verifyroms   check selected game for missing and invalid ROMs.
  329. -verifysamples check selected game for missing samples.
  330. -romdir       specify an alternate directory/zip name where to load the ROMs
  331.               for the specified game. E.g. "mame pacman -romdir pachack" will
  332.               run the Pac Man driver but load the roms from the "pachack" dir
  333.               or "pachack.zip" archive.
  334. -mouse/-nomouse (default: -mouse) enable/disable mouse support
  335. -frameskip n  skip frames to speed up the emulation. For example, if the game
  336.               normally runs at 60 fps, "-frameskip 1" will make it run at 30
  337.               fps, and "-frameskip 2" at 20 fps. Use F11 to check the speed
  338.               your computer is actually reaching. If the game is too slow,
  339.               increase the frameskip value. Note that this setting can also
  340.               affect audio quality (some games sound better, others sound
  341.               worse).  Maximum value for frameskip is 3.
  342. -antialias/-noantialias (default: -antialias)
  343.               antialiasing for the vector games.
  344. -beam n       sets the width in pixels of the vectors. n is a float in the
  345.               range of 1.00 through 16.00.
  346. -flicker n    make the vectors flicker. n is an optional argument, a float in
  347.               the range 0.00 - 100.00 (0=none 100=maximum).
  348. -cheat        Cheats like the speedup in Pac Man or the level skip in many
  349.               other games are disabled by default. Use this switch to turn
  350.               them on.
  351. -debug        Activate the integrated debugger. During the emulation, press
  352.               tilde to enter the debugger.
  353. -record name   Record joystick input on file INP/name.inp.
  354. -playback name Playback joystick input from file INP/name.inp.
  355. -savecfg      no longer supported at the moment
  356. -ignorecfg    ignore mame.cfg and start with the default settings
  357.  
  358.  
  359. The following keys work in all emulators:
  360. Tab          Enter configuration menu. Press Tab or Esc to get back to the
  361.              emulation.
  362. P            Pause
  363. F3           Reset
  364. F4           Show the game graphics. Use cursor keys to change set/color,
  365.              F4 or Esc to return to the emulation.
  366. F7           Calibrate the joystick
  367. F8           Change frame skip on the fly (60, 30, 20, or 15)
  368. F10          Toggle speed throttling
  369. F11          Toggle speed display
  370. F12          Save a screen snapshot. The default target directory is PCX, you
  371.              have to create it yourself, it will not be created by the program
  372.              if it isn't there.
  373. numpad +/-   Volume adjust
  374. left shift + numpad +/- Gamma correction adjust
  375. ESC          Exit emulator
  376.